1 /*
2 * $Header: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/io/id/SequentialIDGenerator.java,v 1.3 2002/08/14 18:50:21 rdonkin Exp $
3 * $Revision: 1.3 $
4 * $Date: 2002/08/14 18:50:21 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>;.
59 *
60 * $Id: SequentialIDGenerator.java,v 1.3 2002/08/14 18:50:21 rdonkin Exp $
61 */
62 package org.apache.commons.betwixt.io.id;
63
64
65 /*** <p>Generates <code>ID</code>'s in numeric sequence.
66 * A simple counter is used.
67 * Every time that {@link #nextIdImpl} is called,
68 * this counter is incremented.</p>
69 *
70 * <p>By default, the counter starts at zero.
71 * A user can set the initial value by using the
72 * {@link #SequentialIDGenerator(int start)} constructor.</p>
73 *
74 * @author <a href="mailto:rdonkin@apache.org">Robert Burrell Donkin</a>
75 * @version $Revision: 1.3 $
76 */
77 public final class SequentialIDGenerator extends AbstractIDGenerator {
78
79 /*** Counter used to assign <code>ID</code>'s */
80 private int counter = 0;
81
82 /***
83 * Base constructor.
84 * Counter starts at zero.
85 */
86 public SequentialIDGenerator() {}
87
88 /***
89 * Constructor sets the start value for the counter.
90 *
91 * <p><strong>Note</strong> since the counter increments
92 * before returning the next value,
93 * first <code>ID</code> generated will be <em>one more</em>
94 * than the given <code>start</code> parameter.</p>
95 *
96 * @param start start the counting at this value
97 */
98 public SequentialIDGenerator(int start) {
99 this.counter = start;
100 }
101
102 /***
103 * Increment counter and then return value.
104 */
105 public String nextIdImpl() {
106 return Integer.toString(++counter);
107 }
108
109 /***
110 * Get the current counter value
111 */
112 public int getCount() {
113 return counter;
114 }
115 }
This page was automatically generated by Maven